-
Notifications
You must be signed in to change notification settings - Fork 263
/
SearchResults`1.xml
186 lines (186 loc) · 10.6 KB
/
SearchResults`1.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
<Type Name="SearchResults<T>" FullName="Azure.Search.Documents.Models.SearchResults<T>">
<TypeSignature Language="C#" Value="public class SearchResults<T>" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SearchResults`1<T> extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.Search.Documents.Models.SearchResults`1" />
<TypeSignature Language="VB.NET" Value="Public Class SearchResults(Of T)" />
<TypeSignature Language="F#" Value="type SearchResults<'T> = class" />
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.2.0.0</AssemblyVersion>
<AssemblyVersion>11.2.1.0</AssemblyVersion>
<AssemblyVersion>11.3.0.0</AssemblyVersion>
<AssemblyVersion>11.4.0.0</AssemblyVersion>
<AssemblyVersion>11.5.0.0</AssemblyVersion>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
<AssemblyVersion>11.7.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<typeparam name="T">To be added.</typeparam>
<summary>
Response containing search results from an index.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Coverage">
<MemberSignature Language="C#" Value="public double? Coverage { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<float64> Coverage" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Models.SearchResults`1.Coverage" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Coverage As Nullable(Of Double)" />
<MemberSignature Language="F#" Value="member this.Coverage : Nullable<double>" Usage="Azure.Search.Documents.Models.SearchResults<'T>.Coverage" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
<AssemblyVersion>11.7.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Double></ReturnType>
</ReturnValue>
<Docs>
<summary>
A value indicating the percentage of the index that was included in
the query, or null if <see cref="P:Azure.Search.Documents.SearchOptions.MinimumCoverage" />
was not specified in the request.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Facets">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IDictionary<string,System.Collections.Generic.IList<Azure.Search.Documents.Models.FacetResult>> Facets { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IDictionary`2<string, class System.Collections.Generic.IList`1<class Azure.Search.Documents.Models.FacetResult>> Facets" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Models.SearchResults`1.Facets" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Facets As IDictionary(Of String, IList(Of FacetResult))" />
<MemberSignature Language="F#" Value="member this.Facets : System.Collections.Generic.IDictionary<string, System.Collections.Generic.IList<Azure.Search.Documents.Models.FacetResult>>" Usage="Azure.Search.Documents.Models.SearchResults<'T>.Facets" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
<AssemblyVersion>11.7.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IDictionary<System.String,System.Collections.Generic.IList<Azure.Search.Documents.Models.FacetResult>></ReturnType>
</ReturnValue>
<Docs>
<summary>
The facet query results for the search operation, organized as a
collection of buckets for each faceted field; null if the query did
not include any facet expressions via
<see cref="P:Azure.Search.Documents.SearchOptions.Facets" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetResults">
<MemberSignature Language="C#" Value="public Azure.Pageable<Azure.Search.Documents.Models.SearchResult<T>> GetResults ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Azure.Pageable`1<class Azure.Search.Documents.Models.SearchResult`1<!T>> GetResults() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Search.Documents.Models.SearchResults`1.GetResults" />
<MemberSignature Language="VB.NET" Value="Public Function GetResults () As Pageable(Of SearchResult(Of T))" />
<MemberSignature Language="F#" Value="member this.GetResults : unit -> Azure.Pageable<Azure.Search.Documents.Models.SearchResult<'T>>" Usage="searchResults.GetResults " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
<AssemblyVersion>11.7.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<Azure.Search.Documents.Models.SearchResult<T>></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Get all of the <see cref="T:Azure.Search.Documents.Models.SearchResult`1" />s synchronously.
</summary>
<returns>The search results.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetResultsAsync">
<MemberSignature Language="C#" Value="public Azure.AsyncPageable<Azure.Search.Documents.Models.SearchResult<T>> GetResultsAsync ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Azure.AsyncPageable`1<class Azure.Search.Documents.Models.SearchResult`1<!T>> GetResultsAsync() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Search.Documents.Models.SearchResults`1.GetResultsAsync" />
<MemberSignature Language="VB.NET" Value="Public Function GetResultsAsync () As AsyncPageable(Of SearchResult(Of T))" />
<MemberSignature Language="F#" Value="member this.GetResultsAsync : unit -> Azure.AsyncPageable<Azure.Search.Documents.Models.SearchResult<'T>>" Usage="searchResults.GetResultsAsync " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
<AssemblyVersion>11.7.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<Azure.Search.Documents.Models.SearchResult<T>></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Get all of the <see cref="T:Azure.Search.Documents.Models.SearchResult`1" />s asynchronously.
</summary>
<returns>The search results.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SemanticSearch">
<MemberSignature Language="C#" Value="public Azure.Search.Documents.Models.SemanticSearchResults SemanticSearch { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Azure.Search.Documents.Models.SemanticSearchResults SemanticSearch" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Models.SearchResults`1.SemanticSearch" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property SemanticSearch As SemanticSearchResults" />
<MemberSignature Language="F#" Value="member this.SemanticSearch : Azure.Search.Documents.Models.SemanticSearchResults" Usage="Azure.Search.Documents.Models.SearchResults<'T>.SemanticSearch" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
<AssemblyVersion>11.7.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Search.Documents.Models.SemanticSearchResults</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the semantic search result.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TotalCount">
<MemberSignature Language="C#" Value="public long? TotalCount { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int64> TotalCount" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Models.SearchResults`1.TotalCount" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property TotalCount As Nullable(Of Long)" />
<MemberSignature Language="F#" Value="member this.TotalCount : Nullable<int64>" Usage="Azure.Search.Documents.Models.SearchResults<'T>.TotalCount" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
<AssemblyVersion>11.7.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Int64></ReturnType>
</ReturnValue>
<Docs>
<summary>
The total count of results found by the search operation, or null
if the count was not requested via
<see cref="P:Azure.Search.Documents.SearchOptions.IncludeTotalCount" />. If present, the
count may be greater than the number of results in this response.
This can happen if you use the <see cref="P:Azure.Search.Documents.SearchOptions.Size" /> or
<see cref="P:Azure.Search.Documents.SearchOptions.Skip" /> parameters, or if Azure Cognitive
Search can't return all the requested documents in a single Search
response.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>